<div >
<h2><a id="AbbreviationAsWordInName"></a>AbbreviationAsWordInName</h2>
      
<div class="section">
<h3><a id="Description"></a>Description</h3>
        
<p>
         The Check validate abbreviations(consecutive capital letters)
         length in identifier name, it also allows to enforce camel case naming. Please read more at
         <a class="externalLink" href="http://checkstyle.sourceforge.net/reports/google-java-style.html#s5.3-camel-case">
         Google Style Guide</a>
         to get to know how to avoid long abbreviations in names.
        </p>
      </div>

       
<div class="section">
<h3><a id="Properties"></a>Properties</h3>
        
<table class="bodyTable">
          
<tbody><tr class="a">
            
<th>name</th>
            
<th>description</th>
            
<th>type</th>
            
<th>default value</th>
          </tr>
          
<tr class="b">
            
<td>allowedAbbreviationLength</td>
            
<td>indicates on the allowed amount of capital letters in targeted identifiers
             (abbreviations in the classes, interfaces, variables and methods names, ... ).</td>
            
<td><a href="http://checkstyle.sourceforge.net/property_types.html#integer">Integer</a></td>
            
<td>3</td>
          </tr>
          
<tr class="a">
            
<td>allowedAbbreviations</td>
            
<td>list of abbreviations that must be skipped for checking.
            Abbreviations should be separated by comma, no spaces are allowed.</td>
            
<td><a href="http://checkstyle.sourceforge.net/property_types.html#stringSet">String Set</a></td>
            
<td>null</td>
          </tr>
          
<tr class="b">
            
<td>ignoreFinal</td>
            
<td>allow to skip variables with final modifier.</td>
            
<td><a href="http://checkstyle.sourceforge.net/property_types.html#boolean">Boolean</a></td>
            
<td>true</td>
          </tr>
          
<tr class="a">
            
<td>ignoreStatic</td>
            
<td>allow to skip variables with static modifier.</td>
            
<td><a href="http://checkstyle.sourceforge.net/property_types.html#boolean">Boolean</a></td>
            
<td>true</td>
          </tr>
          
<tr class="b">
            
<td>ignoreOverriddenMethods</td>
            
<td>Allows to ignore methods tagged with @Override annotation
            (that usually mean inherited name).</td>
            
<td><a href="http://checkstyle.sourceforge.net/property_types.html#boolean">Boolean</a></td>
            
<td>true</td>
          </tr>
          
<tr class="a">
            
<td>tokens</td>
            
<td>tokens to check</td>
            
<td>
              subset of tokens
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CLASS_DEF">CLASS_DEF</a>,
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INTERFACE_DEF">INTERFACE_DEF</a>,
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_DEF">ENUM_DEF</a>,
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_DEF">ANNOTATION_DEF</a>,
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_FIELD_DEF">ANNOTATION_FIELD_DEF</a>,
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#PARAMETER_DEF">PARAMETER_DEF</a>,
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#VARIABLE_DEF">VARIABLE_DEF</a>,
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">METHOD_DEF</a>,
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_CONSTANT_DEF">ENUM_CONSTANT_DEF</a>.
            </td>
            
<td>
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CLASS_DEF">CLASS_DEF</a>,
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INTERFACE_DEF">INTERFACE_DEF</a>,
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_DEF">ENUM_DEF</a>,
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_DEF">ANNOTATION_DEF</a>,
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_FIELD_DEF">ANNOTATION_FIELD_DEF</a>,
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#PARAMETER_DEF">PARAMETER_DEF</a>,
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#VARIABLE_DEF">VARIABLE_DEF</a>,
              <a href="http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">METHOD_DEF</a>.
            </td>
          </tr>
        </tbody></table>
      </div>

      
<div class="section">
<h3><a id="Examples"></a>Examples</h3>
       
<p>
         Default configuration
         </p>
<div class="source">
<pre>&lt;module name="AbbreviationAsWordInName"/&gt;
         </pre></div>
       
       
<p>
          To configure to check variables and classes identifiers,
          do not ignore variables with static modifier and allow
          no abbreviations (enforce camel case phrase) and
          allow no abbreviations to use (camel case phrase) and allow XML and URL abbreviations.
        </p>
        
<div class="source">
<pre>&lt;module name="AbbreviationAsWordInName"&gt;
    &lt;property name="tokens" value="VARIABLE_DEF,CLASS_DEF"/&gt;
    &lt;property name="ignoreStatic" value="false"/&gt;
    &lt;property name="allowedAbbreviationLength" value="1"/&gt;
    &lt;property name="allowedAbbreviations" value="XML,URL"/&gt;
&lt;/module&gt;
        </pre></div>
      </div>

</div>